0 追蹤者

類別 yii\validators\NumberValidator

繼承關係yii\validators\NumberValidator » yii\validators\Validator » yii\base\Component » yii\base\BaseObject
實作yii\base\Configurable
自版本起可用2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/validators/NumberValidator.php

NumberValidator 驗證屬性值是否為數字。

數字的格式必須符合 $integerPattern$numberPattern 中指定的正規表示式。或者,您可以設定 $max$min 屬性,以確保數字在特定範圍內。

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$allowArray boolean 是否允許陣列類型屬性。 yii\validators\NumberValidator
$attributeNames array 屬性名稱。 yii\validators\Validator
$attributes array|string 由此驗證器驗證的屬性。 yii\validators\Validator
$behaviors yii\base\Behavior[] 附加到此組件的行為列表。 yii\base\Component
$builtInValidators array 內建驗證器的列表 (name => class 或配置) yii\validators\Validator
$enableClientValidation boolean 是否为此验证器启用客户端验证。 yii\validators\Validator
$except array|string 驗證器不應套用的情境。 yii\validators\Validator
$integerOnly boolean 屬性值是否只能是整數。 yii\validators\NumberValidator
$integerPattern string 用於匹配整數的正規表示式。 yii\validators\NumberValidator
$isEmpty callable|null 一個 PHP 可呼叫的函式,用於替換 isEmpty() 的預設實作。 yii\validators\Validator
$max integer|float|null 數字的上限。 yii\validators\NumberValidator
$message string|null 使用者定義的錯誤訊息。 yii\validators\Validator
$min integer|float|null 數字的下限。 yii\validators\NumberValidator
$numberPattern string 用於匹配數字的正規表示式。 yii\validators\NumberValidator
$on array|string 驗證器可以套用的情境。 yii\validators\Validator
$skipOnEmpty boolean 如果屬性值為 null 或空字串,是否應跳過此驗證規則。 yii\validators\Validator
$skipOnError boolean 如果根據先前的規則,要驗證的屬性已經存在某些驗證錯誤,是否應跳過此驗證規則。 yii\validators\Validator
$tooBig string 當值大於 $max 時使用的使用者定義錯誤訊息。 yii\validators\NumberValidator
$tooSmall string 當值小於 $min 時使用的使用者定義錯誤訊息。 yii\validators\NumberValidator
$validationAttributes array|null 屬性名稱列表。 yii\validators\Validator
$when callable|null 一個 PHP 可呼叫的函式,其傳回值決定是否應套用此驗證器。 yii\validators\Validator
$whenClient string|null 一個 JavaScript 函式名稱,其傳回值決定是否應在客戶端套用此驗證器。 yii\validators\Validator

公開方法

隱藏繼承的方法

方法 描述 定義於
__call() 呼叫未作為類別方法的具名方法。 yii\base\Component
__clone() 在透過複製現有物件建立物件後,會呼叫此方法。 yii\base\Component
__construct() 建構子。 yii\base\BaseObject
__get() 傳回組件屬性的值。 yii\base\Component
__isset() 檢查是否已設定屬性,即已定義且非 null。 yii\base\Component
__set() 設定組件屬性的值。 yii\base\Component
__unset() 將組件屬性設定為 null。 yii\base\Component
addError() 將指定屬性的錯誤新增到模型物件。 yii\validators\Validator
attachBehavior() 將行為附加到此組件。 yii\base\Component
attachBehaviors() 將行為列表附加到組件。 yii\base\Component
behaviors() 傳回此組件應表現為的行為列表。 yii\base\Component
canGetProperty() 傳回指示是否可以讀取屬性的值。 yii\base\Component
canSetProperty() 傳回指示是否可以設定屬性的值。 yii\base\Component
className() 傳回此類別的完整限定名稱。 yii\base\BaseObject
clientValidateAttribute() 傳回執行客戶端驗證所需的 JavaScript。 yii\validators\NumberValidator
createValidator() 建立驗證器物件。 yii\validators\Validator
detachBehavior() 從組件分離行為。 yii\base\Component
detachBehaviors() 從組件分離所有行為。 yii\base\Component
ensureBehaviors() 確保在 behaviors() 中宣告的行為 (behaviors) 已附加到此元件。 yii\base\Component
getAttributeNames() 傳回已清理的屬性名稱,開頭不含 ! 字元。 yii\validators\Validator
getBehavior() 傳回指定的行為 (behavior) 物件。 yii\base\Component
getBehaviors() 傳回附加到此元件的所有行為 (behaviors)。 yii\base\Component
getClientOptions() 傳回用戶端驗證選項。 yii\validators\NumberValidator
getValidationAttributes() 傳回此驗證器 (validator) 應用於驗證的屬性列表。 yii\validators\Validator
hasEventHandlers() 傳回一個值,指示是否有名稱事件附加任何處理器 (handler)。 yii\base\Component
hasMethod() 傳回一個值,指示是否已定義方法 (method)。 yii\base\Component
hasProperty() 傳回一個值,指示是否已為此元件定義屬性 (property)。 yii\base\Component
init() 初始化物件。 yii\validators\NumberValidator
isActive() 傳回一個值,指示驗證器 (validator) 是否對於給定的情境 (scenario) 和屬性 (attribute) 為啟用狀態。 yii\validators\Validator
isEmpty() 檢查給定的值是否為空。 yii\validators\Validator
off() 從此元件分離現有的事件處理器 (event handler)。 yii\base\Component
on() 將事件處理器 (event handler) 附加到事件。 yii\base\Component
trigger() 觸發事件。 yii\base\Component
validate() 驗證給定的值。 yii\validators\Validator
validateAttribute() 驗證單一屬性 (attribute)。 yii\validators\NumberValidator
validateAttributes() 驗證指定的物件。 yii\validators\Validator

受保護的方法 (Protected Methods)

隱藏繼承的方法

方法 描述 定義於
formatMessage() 使用 I18N 格式化訊息,如果 \Yii::$app 無法使用,則使用簡單的 strtr。 yii\validators\Validator
validateValue() 驗證一個值。 yii\validators\NumberValidator

屬性詳細資訊 (Property Details)

隱藏繼承的屬性

$allowArray 公開屬性 (public property) (自版本 2.0.42 起可用)

是否允許陣列 (array) 類型的屬性。預設為 false。

public boolean $allowArray false
$integerOnly 公開屬性 (public property)

屬性值是否只能是整數 (integer)。預設為 false。

public boolean $integerOnly false
$integerPattern 公開屬性 (public property)

用於匹配整數的正規表示式。

public string $integerPattern '/^[+-]?\d+$/'
$max 公開屬性 (public property)

數字的上限。預設為 null,表示沒有上限。

另請參閱 $tooBig 以取得當數字過大時使用的自訂訊息。

public integer|float|null $max null
$min 公開屬性 (public property)

數字的下限。預設為 null,表示沒有下限。

另請參閱 $tooSmall 以取得當數字過小時使用的自訂訊息。

public integer|float|null $min null
$numberPattern 公開屬性 (public property)

用於匹配數字的正規表示式 (regular expression)。預設為匹配浮點數 (floating numbers) 的模式,可選指數部分 (例如 -1.23e-10)。

public string $numberPattern '/^[-+]?[0-9]*\.?[0-9]+([eE][-+]?[0-9]+)?$/'
$tooBig 公開屬性 (public property)

當值大於 $max 時使用的使用者定義錯誤訊息。

public string $tooBig null
$tooSmall 公開屬性 (public property)

當值小於 $min 時使用的使用者定義錯誤訊息。

public string $tooSmall null

方法詳細資訊 (Method Details)

隱藏繼承的方法

__call() 公開方法 (public method)

定義於: yii\base\Component::__call()

呼叫未作為類別方法的具名方法。

此方法將檢查是否有任何附加的行為 (behavior) 具有指定名稱的方法 (method),如果有的話則會執行它。

請勿直接呼叫此方法,因為它是 PHP 的魔術方法 (magic method),當呼叫未知的方法時,會被隱式地呼叫。

public mixed __call ( $name, $params )
$name string

方法名稱

$params array

方法參數

傳回 mixed (混合)

方法傳回值

拋出 yii\base\UnknownMethodException

當呼叫未知方法時

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() 公開方法 (public method)

定義於: yii\base\Component::__clone()

在透過複製現有物件建立物件後,會呼叫此方法。

它會移除所有行為 (behaviors),因為它們是附加到舊物件的。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() 公開方法 (public method)

定義於: yii\base\BaseObject::__construct()

建構子。

預設實作會執行兩件事

  • 使用給定的組態 $config 初始化物件。
  • 呼叫 init()

如果在子類別中覆寫此方法,建議

  • 建構子的最後一個參數是一個組態陣列,就像此處的 $config 一樣。
  • 在建構子的結尾呼叫父類別的實作。
public void __construct ( $config = [] )
$config (組態) array

將用於初始化物件屬性的名稱-值 (name-value) 配對

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

            
__get() 公開方法 (public method)

定義於: yii\base\Component::__get()

傳回組件屬性的值。

此方法將依以下順序檢查並相應地執行動作

  • 由 getter 定義的屬性:傳回 getter 結果
  • 行為 (behavior) 的屬性:傳回行為屬性值

請勿直接呼叫此方法,因為它是 PHP 的魔術方法 (magic method),當執行 $value = $component->property; 時,會被隱式地呼叫。

另請參閱 __set()

public mixed __get ( $name )
$name string

屬性名稱

傳回 mixed (混合)

屬性值或行為 (behavior) 屬性的值

拋出 yii\base\UnknownPropertyException

如果未定義屬性

拋出 yii\base\InvalidCallException

如果屬性為唯寫。

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() 公開方法 (public method)

定義於: yii\base\Component::__isset()

檢查是否已設定屬性,即已定義且非 null。

此方法將依以下順序檢查並相應地執行動作

  • 由 setter 定義的屬性:傳回屬性是否已設定
  • 行為 (behavior) 的屬性:傳回屬性是否已設定
  • 對於不存在的屬性傳回 false

請勿直接呼叫此方法,因為它是 PHP 的魔術方法 (magic method),當執行 isset($component->property) 時,會被隱式地呼叫。

另請參閱 https://php.dev.org.tw/manual/en/function.isset.php

public boolean __isset ( $name )
$name string

屬性名稱或事件名稱

傳回 boolean

名稱屬性是否已設定

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() 公開方法 (public method)

定義於: yii\base\Component::__set()

設定組件屬性的值。

此方法將依以下順序檢查並相應地執行動作

  • 由 setter 定義的屬性:設定屬性值
  • 格式為 "on xyz" 的事件:將處理器 (handler) 附加到事件 "xyz"
  • 格式為 "as xyz" 的行為 (behavior):附加名為 "xyz" 的行為
  • 行為 (behavior) 的屬性:設定行為屬性值

請勿直接呼叫此方法,因為它是 PHP 的魔術方法 (magic method),當執行 $component->property = $value; 時,會被隱式地呼叫。

另請參閱 __get()

public void __set ( $name, $value )
$name string

屬性名稱或事件名稱

$value (屬性值) mixed (混合)

屬性值

拋出 yii\base\UnknownPropertyException

如果未定義屬性

拋出 yii\base\InvalidCallException

如果屬性為唯讀。

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() 公開方法 (public method)

定義於: yii\base\Component::__unset()

將組件屬性設定為 null。

此方法將依以下順序檢查並相應地執行動作

  • 由 setter 定義的屬性:將屬性值設定為 null
  • 行為 (behavior) 的屬性:將屬性值設定為 null

請勿直接呼叫此方法,因為它是 PHP 的魔術方法 (magic method),當執行 unset($component->property) 時,會被隱式地呼叫。

另請參閱 https://php.dev.org.tw/manual/en/function.unset.php

public void __unset ( $name )
$name string

屬性名稱

拋出 yii\base\InvalidCallException

如果屬性為唯讀。

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
addError() 公開方法 (public method)

定義於: yii\validators\Validator::addError()

將指定屬性的錯誤新增到模型物件。

這是一個輔助方法 (helper method),用於執行訊息選擇和國際化 (internationalization)。

public void addError ( $model, $attribute, $message, $params = [] )
$model (模型) yii\base\Model

正在驗證的資料模型 (data model)

$attribute (屬性) string

正在驗證的屬性 (attribute)

$message string

錯誤訊息

$params array

錯誤訊息中佔位符 (placeholders) 的值

                public function addError($model, $attribute, $message, $params = [])
{
    $params['attribute'] = $model->getAttributeLabel($attribute);
    if (!isset($params['value'])) {
        $value = $model->$attribute;
        if (is_array($value)) {
            $params['value'] = 'array()';
        } elseif (is_object($value) && !method_exists($value, '__toString')) {
            $params['value'] = '(object)';
        } else {
            $params['value'] = $value;
        }
    }
    $model->addError($attribute, $this->formatMessage($message, $params));
}

            
attachBehavior() 公開方法 (public method)

定義於: yii\base\Component::attachBehavior()

將行為附加到此組件。

此方法將根據給定的組態建立行為 (behavior) 物件。之後,將透過呼叫 yii\base\Behavior::attach() 方法,將行為物件附加到此元件。

另請參閱 detachBehavior()

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行為 (behavior) 的名稱。

$behavior (行為) string|array|yii\base\Behavior

行為 (behavior) 組態。這可以是以下其中之一

  • 一個 yii\base\Behavior 物件
  • 一個字串 (string),指定行為 (behavior) 類別
  • 一個物件組態陣列,將被傳遞給 Yii::createObject() 以建立行為 (behavior) 物件。
傳回 yii\base\Behavior

行為 (behavior) 物件

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() 公開方法 (public method)

定義於: yii\base\Component::attachBehaviors()

將行為列表附加到組件。

每個行為 (behavior) 都以其名稱索引,並且應該是一個 yii\base\Behavior 物件、一個指定行為類別的字串 (string),或是一個用於建立行為的組態陣列。

另請參閱 attachBehavior()

public void attachBehaviors ( $behaviors )
$behaviors array

要附加到元件的行為 (behaviors) 列表

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
behaviors() 公開方法 (public method)

定義於: yii\base\Component::behaviors()

傳回此組件應表現為的行為列表。

子類別可以覆寫此方法,以指定它們想要表現為哪些行為 (behaviors)。

此方法的傳回值應該是一個行為 (behavior) 物件或組態的陣列,並以行為名稱索引。行為組態可以是指定行為類別的字串 (string),或是以下結構的陣列

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

請注意,行為 (behavior) 類別必須繼承自 yii\base\Behavior。行為可以使用名稱或匿名方式附加。當使用名稱作為陣列鍵時,可以使用此名稱,稍後使用 getBehavior() 檢索行為,或使用 detachBehavior() 分離行為。匿名行為無法被檢索或分離。

在此方法中宣告的行為 (behaviors) 將會自動 (依需求) 附加到元件。

public array behaviors ( )
傳回 array

行為 (behavior) 組態。

                public function behaviors()
{
    return [];
}

            
canGetProperty() 公開方法 (public method)

定義於: yii\base\Component::canGetProperty()

傳回指示是否可以讀取屬性的值。

如果符合以下條件,則可以讀取屬性

  • 類別具有與指定名稱關聯的 getter 方法 (在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數 (當 $checkVars 為 true 時);
  • 附加的行為 (behavior) 具有給定名稱的可讀屬性 (當 $checkBehaviors 為 true 時)。

另請參閱 canSetProperty()

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

屬性名稱

$checkVars (檢查變數) boolean

是否將成員變數視為屬性

$checkBehaviors (檢查行為) boolean

是否將行為 (behaviors) 的屬性視為此元件的屬性

傳回 boolean

屬性是否可以被讀取

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() 公開方法 (public method)

定義於: yii\base\Component::canSetProperty()

傳回指示是否可以設定屬性的值。

如果符合以下條件,則可以寫入屬性

  • 類別具有與指定名稱關聯的 setter 方法 (在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數 (當 $checkVars 為 true 時);
  • 附加的行為 (behavior) 具有給定名稱的可寫屬性 (當 $checkBehaviors 為 true 時)。

另請參閱 canGetProperty()

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

屬性名稱

$checkVars (檢查變數) boolean

是否將成員變數視為屬性

$checkBehaviors (檢查行為) boolean

是否將行為 (behaviors) 的屬性視為此元件的屬性

傳回 boolean

屬性是否可以被寫入

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() 公開靜態方法 (public static method)
自 2.0.14 版本起已過時。在 PHP >=5.5 版本中,請改用 ::class

定義於: yii\base\BaseObject::className()

傳回此類別的完整限定名稱。

public static string className ( )
傳回 string

此類別的完整限定名稱。

                public static function className()
{
    return get_called_class();
}

            
clientValidateAttribute() 公開方法 (public method)

傳回執行客戶端驗證所需的 JavaScript。

呼叫 getClientOptions() 以產生用於用戶端驗證的選項陣列。

如果驗證器 (validator) 可以支援用戶端驗證,您可以覆寫此方法以傳回 JavaScript 驗證程式碼。

以下 JavaScript 變數是預先定義的,可以在驗證程式碼中使用

  • attribute:描述正在驗證的屬性 (attribute) 的物件。
  • value:正在驗證的值。
  • messages:一個陣列,用於保存屬性 (attribute) 的驗證錯誤訊息。
  • deferred:一個陣列,用於保存非同步驗證的延遲物件 (deferred objects)
  • $form:一個包含表單元素 (form element) 的 jQuery 物件

attribute 物件包含以下屬性

  • id:在表單中識別屬性的唯一 ID (例如 "loginform-username")
  • name:屬性名稱或表達式 (例如,表格輸入的 "[0]content")
  • container:輸入欄位 (input field) 容器的 jQuery 選擇器 (selector)
  • input:在表單上下文中輸入欄位 (input field) 的 jQuery 選擇器 (selector)
  • error:容器上下文中錯誤標籤的 jQuery 選擇器
  • status:輸入欄位的狀態,0:空白,之前未輸入,1:已驗證,2:等待驗證,3:驗證中
public string|null clientValidateAttribute ( $model, $attribute, $view )
$model (模型) yii\base\Model

正在驗證的資料模型 (data model)

$attribute (屬性) string

要驗證的屬性名稱。

$view yii\web\View

將用於呈現視圖或包含應用此驗證器的模型表單的視圖檔案的視圖物件。

傳回 string|null

客戶端驗證腳本。如果驗證器不支援客戶端驗證,則為 Null。

                public function clientValidateAttribute($model, $attribute, $view)
{
    ValidationAsset::register($view);
    $options = $this->getClientOptions($model, $attribute);
    return 'yii.validation.number(value, messages, ' . Json::htmlEncode($options) . ');';
}

            
createValidator() public static method

定義於: yii\validators\Validator::createValidator()

建立驗證器物件。

public static yii\validators\Validator createValidator ( $type, $model, $attributes, $params = [] )
$type string|Closure

驗證器類型。這可以是:

  • $builtInValidators 中列出的內建驗證器名稱;
  • 模型類別的方法名稱;
  • 匿名函式;
  • 驗證器類別名稱。
$model (模型) yii\base\Model

要驗證的資料模型。

$attributes array|string

要驗證的屬性列表。這可以是屬性名稱的陣列或逗號分隔的屬性名稱字串。

$params array

要應用於驗證器屬性的初始值。

傳回 yii\validators\Validator

驗證器

                public static function createValidator($type, $model, $attributes, $params = [])
{
    $params['attributes'] = $attributes;
    if ($type instanceof \Closure) {
        $params['class'] = __NAMESPACE__ . '\InlineValidator';
        $params['method'] = $type;
    } elseif (!isset(static::$builtInValidators[$type]) && $model->hasMethod($type)) {
        // method-based validator
        $params['class'] = __NAMESPACE__ . '\InlineValidator';
        $params['method'] = [$model, $type];
    } else {
        unset($params['current']);
        if (isset(static::$builtInValidators[$type])) {
            $type = static::$builtInValidators[$type];
        }
        if (is_array($type)) {
            $params = array_merge($type, $params);
        } else {
            $params['class'] = $type;
        }
    }
    return Yii::createObject($params);
}

            
detachBehavior() public method

定義於: yii\base\Component::detachBehavior()

從組件分離行為。

將調用行為的 yii\base\Behavior::detach() 方法。

public yii\base\Behavior|null detachBehavior ( $name )
$name string

行為的名稱。

傳回 yii\base\Behavior|null

已分離的行為。如果行為不存在,則為 Null。

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() public method

定義於: yii\base\Component::detachBehaviors()

從組件分離所有行為。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
ensureBehaviors() public method

定義於: yii\base\Component::ensureBehaviors()

確保在 behaviors() 中宣告的行為 (behaviors) 已附加到此元件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
formatMessage() protected method (available since version 2.0.12)

定義於: yii\validators\Validator::formatMessage()

使用 I18N 格式化訊息,如果 \Yii::$app 無法使用,則使用簡單的 strtr。

protected string formatMessage ( $message, $params )
$message string
$params array

                protected function formatMessage($message, $params)
{
    if (Yii::$app !== null) {
        return \Yii::$app->getI18n()->format($message, $params, Yii::$app->language);
    }
    $placeholders = [];
    foreach ((array) $params as $name => $value) {
        $placeholders['{' . $name . '}'] = $value;
    }
    return ($placeholders === []) ? $message : strtr($message, $placeholders);
}

            
getAttributeNames() public method (available since version 2.0.12)

定義於: yii\validators\Validator::getAttributeNames()

傳回已清理的屬性名稱,開頭不含 ! 字元。

public array getAttributeNames ( )
傳回 array

屬性名稱。

                public function getAttributeNames()
{
    return array_map(function ($attribute) {
        return ltrim($attribute, '!');
    }, $this->attributes);
}

            
getBehavior() public method

定義於: yii\base\Component::getBehavior()

傳回指定的行為 (behavior) 物件。

public yii\base\Behavior|null getBehavior ( $name )
$name string

行為名稱

傳回 yii\base\Behavior|null

行為物件,如果行為不存在,則為 null

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() public method

定義於: yii\base\Component::getBehaviors()

傳回附加到此元件的所有行為 (behaviors)。

public yii\base\Behavior[] getBehaviors ( )
傳回 yii\base\Behavior[]

附加到此元件的行為列表

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getClientOptions() public method (available since version 2.0.11)

傳回用戶端驗證選項。

此方法通常從 clientValidateAttribute() 呼叫。您可以覆寫此方法以修改將傳遞到客戶端驗證的選項。

public array getClientOptions ( $model, $attribute )
$model (模型) yii\base\Model

正在驗證的模型

$attribute (屬性) string

正在驗證的屬性名稱

傳回 array

客戶端驗證選項

                public function getClientOptions($model, $attribute)
{
    $label = $model->getAttributeLabel($attribute);
    $options = [
        'pattern' => new JsExpression($this->integerOnly ? $this->integerPattern : $this->numberPattern),
        'message' => $this->formatMessage($this->message, [
            'attribute' => $label,
        ]),
    ];
    if ($this->min !== null) {
        // ensure numeric value to make javascript comparison equal to PHP comparison
        // https://github.com/yiisoft/yii2/issues/3118
        $options['min'] = is_string($this->min) ? (float) $this->min : $this->min;
        $options['tooSmall'] = $this->formatMessage($this->tooSmall, [
            'attribute' => $label,
            'min' => $this->min,
        ]);
    }
    if ($this->max !== null) {
        // ensure numeric value to make javascript comparison equal to PHP comparison
        // https://github.com/yiisoft/yii2/issues/3118
        $options['max'] = is_string($this->max) ? (float) $this->max : $this->max;
        $options['tooBig'] = $this->formatMessage($this->tooBig, [
            'attribute' => $label,
            'max' => $this->max,
        ]);
    }
    if ($this->skipOnEmpty) {
        $options['skipOnEmpty'] = 1;
    }
    return $options;
}

            
getValidationAttributes() public method (available since version 2.0.16)

定義於: yii\validators\Validator::getValidationAttributes()

傳回此驗證器 (validator) 應用於驗證的屬性列表。

public array|null getValidationAttributes ( $attributes null )
$attributes array|string|null

要驗證的屬性列表。

傳回 array|null

屬性名稱列表。

                public function getValidationAttributes($attributes = null)
{
    if ($attributes === null) {
        return $this->getAttributeNames();
    }
    if (is_scalar($attributes)) {
        $attributes = [$attributes];
    }
    $newAttributes = [];
    $attributeNames = $this->getAttributeNames();
    foreach ($attributes as $attribute) {
        // do not strict compare, otherwise int attributes would fail due to to string conversion in getAttributeNames() using ltrim().
        if (in_array($attribute, $attributeNames, false)) {
            $newAttributes[] = $attribute;
        }
    }
    return $newAttributes;
}

            
hasEventHandlers() public method

定義於: yii\base\Component::hasEventHandlers()

傳回一個值,指示是否有名稱事件附加任何處理器 (handler)。

public boolean hasEventHandlers ( $name )
$name string

事件名稱

傳回 boolean

是否有任何處理常式附加到事件。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() public method

定義於: yii\base\Component::hasMethod()

傳回一個值,指示是否已定義方法 (method)。

如果滿足以下條件,則定義了方法:

  • 類別具有指定名稱的方法
  • 附加的行為具有給定名稱的方法(當 $checkBehaviors 為 true 時)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

屬性名稱

$checkBehaviors (檢查行為) boolean

是否將行為的方法視為此元件的方法

傳回 boolean

是否定義了方法

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() public method

定義於: yii\base\Component::hasProperty()

傳回一個值,指示是否已為此元件定義屬性 (property)。

如果滿足以下條件,則定義了屬性:

  • 類別具有與指定名稱關聯的 getter 或 setter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數 (當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的屬性(當 $checkBehaviors 為 true 時)。

另請參閱

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

屬性名稱

$checkVars (檢查變數) boolean

是否將成員變數視為屬性

$checkBehaviors (檢查行為) boolean

是否將行為 (behaviors) 的屬性視為此元件的屬性

傳回 boolean

是否定義了屬性

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
init() public method

初始化物件。

在物件使用給定配置初始化後,此方法會在建構函式的結尾被調用。

public void init ( )

                public function init()
{
    parent::init();
    if ($this->message === null) {
        $this->message = $this->integerOnly ? Yii::t('yii', '{attribute} must be an integer.')
            : Yii::t('yii', '{attribute} must be a number.');
    }
    if ($this->min !== null && $this->tooSmall === null) {
        $this->tooSmall = Yii::t('yii', '{attribute} must be no less than {min}.');
    }
    if ($this->max !== null && $this->tooBig === null) {
        $this->tooBig = Yii::t('yii', '{attribute} must be no greater than {max}.');
    }
}

            
isActive() public method

定義於: yii\validators\Validator::isActive()

傳回一個值,指示驗證器 (validator) 是否對於給定的情境 (scenario) 和屬性 (attribute) 為啟用狀態。

如果滿足以下條件,驗證器是活動的:

  • 驗證器的 on 屬性為空,或者
  • 驗證器的 on 屬性包含指定的場景
public boolean isActive ( $scenario )
$scenario string

場景名稱

傳回 boolean

驗證器是否適用於指定的場景。

                public function isActive($scenario)
{
    return !in_array($scenario, $this->except, true) && (empty($this->on) || in_array($scenario, $this->on, true));
}

            
isEmpty() public method

定義於: yii\validators\Validator::isEmpty()

檢查給定的值是否為空。

如果值為 null、空陣列或空字串,則視為空值。請注意,此方法與 PHP empty() 不同。當值為 0 時,它將傳回 false。

public boolean isEmpty ( $value )
$value (屬性值) mixed (混合)

要檢查的值

傳回 boolean

值是否為空

                public function isEmpty($value)
{
    if ($this->isEmpty !== null) {
        return call_user_func($this->isEmpty, $value);
    }
    return $value === null || $value === [] || $value === '';
}

            
off() public method

定義於: yii\base\Component::off()

從此元件分離現有的事件處理器 (event handler)。

此方法與 on() 相反。

注意:如果為事件名稱傳遞了萬用字元模式,則只會移除使用此萬用字元註冊的處理常式,而使用與此萬用字元匹配的純名稱註冊的處理常式將保持不變。

另請參閱 on()

public boolean off ( $name, $handler null )
$name string

事件名稱

$handler callable|null

要移除的事件處理常式。如果為 null,則會移除附加到命名事件的所有處理常式。

傳回 boolean

如果找到並分離處理常式

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() public method

定義於: yii\base\Component::on()

將事件處理器 (event handler) 附加到事件。

事件處理常式必須是有效的 PHP 回呼。以下是一些範例:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

事件處理常式必須使用以下簽名定義:

function ($event)

其中 $event 是一個 yii\base\Event 物件,其中包含與事件關聯的參數。

自 2.0.14 版本起,您可以將事件名稱指定為萬用字元模式

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

另請參閱 off()

public void on ( $name, $handler, $data null, $append true )
$name string

事件名稱

$handler 可呼叫

事件處理常式

$data mixed (混合)

事件觸發時要傳遞給事件處理常式的資料。當調用事件處理常式時,可以透過 yii\base\Event::$data 存取此資料。

$append boolean

是否將新的事件處理常式附加到現有處理常式列表的末尾。如果為 false,則新處理常式將插入到現有處理常式列表的開頭。

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
trigger() public method

定義於: yii\base\Component::trigger()

觸發事件。

此方法表示事件的發生。它調用事件的所有附加處理常式,包括類別級別的處理常式。

public void trigger ( $name, yii\base\Event $event null )
$name string

事件名稱

$event yii\base\Event|null

事件實例。如果未設定,將建立預設的 yii\base\Event 物件。

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}

            
validate() public method

定義於: yii\validators\Validator::validate()

驗證給定的值。

您可以使用此方法驗證資料模型上下文之外的值。

public boolean validate ( $value, &$error null )
$value (屬性值) mixed (混合)

要驗證的資料值。

$error string|null

如果驗證失敗,要傳回的錯誤訊息。

傳回 boolean

資料是否有效。

                public function validate($value, &$error = null)
{
    $result = $this->validateValue($value);
    if (empty($result)) {
        return true;
    }
    list($message, $params) = $result;
    $params['attribute'] = Yii::t('yii', 'the input value');
    if (is_array($value)) {
        $params['value'] = 'array()';
    } elseif (is_object($value)) {
        $params['value'] = 'object';
    } else {
        $params['value'] = $value;
    }
    $error = $this->formatMessage($message, $params);
    return false;
}

            
validateAttribute() public method

驗證單一屬性 (attribute)。

子類別必須實作此方法以提供實際的驗證邏輯。

public void validateAttribute ( $model, $attribute )
$model (模型) yii\base\Model

要驗證的資料模型

$attribute (屬性) string

要驗證的屬性名稱。

                public function validateAttribute($model, $attribute)
{
    $value = $model->$attribute;
    if (is_array($value) && !$this->allowArray) {
        $this->addError($model, $attribute, $this->message);
        return;
    }
    $values = !is_array($value) ? [$value] : $value;
    foreach ($values as $value) {
        if ($this->isNotNumber($value)) {
            $this->addError($model, $attribute, $this->message);
            return;
        }
        $pattern = $this->integerOnly ? $this->integerPattern : $this->numberPattern;
        if (!preg_match($pattern, StringHelper::normalizeNumber($value))) {
            $this->addError($model, $attribute, $this->message);
        }
        if ($this->min !== null && $value < $this->min) {
            $this->addError($model, $attribute, $this->tooSmall, ['min' => $this->min]);
        }
        if ($this->max !== null && $value > $this->max) {
            $this->addError($model, $attribute, $this->tooBig, ['max' => $this->max]);
        }
    }
}

            
validateAttributes() public method

定義於: yii\validators\Validator::validateAttributes()

驗證指定的物件。

public void validateAttributes ( $model, $attributes null )
$model (模型) yii\base\Model

正在驗證的資料模型 (data model)

$attributes array|string|null

要驗證的屬性列表。請注意,如果屬性未與驗證器關聯,則會被忽略。如果此參數為 null,則將驗證 $attributes 中列出的每個屬性。

                public function validateAttributes($model, $attributes = null)
{
    $attributes = $this->getValidationAttributes($attributes);
    foreach ($attributes as $attribute) {
        $skip = $this->skipOnError && $model->hasErrors($attribute)
            || $this->skipOnEmpty && $this->isEmpty($model->$attribute);
        if (!$skip) {
            if ($this->when === null || call_user_func($this->when, $model, $attribute)) {
                $this->validateAttribute($model, $attribute);
            }
        }
    }
}

            
validateValue() protected method

驗證一個值。

驗證器類別可以實作此方法,以支援在資料模型上下文之外的資料驗證。

protected array|null validateValue ( $value )
$value (屬性值) mixed (混合)

要驗證的資料值。

傳回 array|null

錯誤訊息和要插入錯誤訊息的參數陣列。 `php if (!$valid) {

return [$this->message, [
    'param1' => $this->param1,
    'formattedLimit' => Yii::$app->formatter->asShortSize($this->getSizeLimit()),
    'mimeTypes' => implode(', ', $this->mimeTypes),
    'param4' => 'etc...',
]];

}

return null; ` 對於此範例,message 模板可以包含 {param1}{formattedLimit}{mimeTypes}{param4}

如果資料有效,則應傳回 Null。

拋出 yii\base\NotSupportedException

如果驗證器不支援在沒有模型的情況下進行資料驗證

                protected function validateValue($value)
{
    if (is_array($value) && !$this->allowArray) {
        return [$this->message, []];
    }
    $values = !is_array($value) ? [$value] : $value;
    foreach ($values as $sample) {
        if ($this->isNotNumber($sample)) {
            return [$this->message, []];
        }
        $pattern = $this->integerOnly ? $this->integerPattern : $this->numberPattern;
        if (!preg_match($pattern, StringHelper::normalizeNumber($sample))) {
            return [$this->message, []];
        } elseif ($this->min !== null && $sample < $this->min) {
            return [$this->tooSmall, ['min' => $this->min]];
        } elseif ($this->max !== null && $sample > $this->max) {
            return [$this->tooBig, ['max' => $this->max]];
        }
    }
    return null;
}